<!doctype html>
<html> 
 <head> 
  <meta charset="utf-8"> 
  <title>表单模块文档 - Layui</title> 
  <meta name="renderer" content="webkit"> 
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> 
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> 
  <meta name="apple-mobile-web-app-status-bar-style" content="black"> 
  <meta name="apple-mobile-web-app-capable" content="yes"> 
  <meta name="format-detection" content="telephone=no"> 
  <link rel="stylesheet" href="/layui/dist/css/layui.css" media="all"> 
  <link rel="stylesheet" href="/static/css/global.css" media="all"> 
 </head> 
 <body> 
  <div class="layui-header header header-doc"> 
   <div class="layui-container"> <a class="logo" href="/index.html"> <img src="/static/images/layui/logo.png" alt="layui"> </a> 
    <div class="layui-form layui-hide-xs component" lay-filter="LAY-site-header-component"></div> 
    <div class="layui-hide-xs site-notice"></div> 
    <ul class="layui-nav" id="LAY_NAV_TOP"> 
     <li class="layui-nav-item layui-this"> <a href="/doc/index.html">文档</a> </li> 
     <li class="layui-nav-item "> <a href="/demo/index.html">示例</a> </li> 
     <li class="layui-nav-item"> <a href="javascript:;"> <!--<span class="layui-badge-dot" style="left:0; right: auto; margin: -4px 0 0 5px;"></span>--> 周边 </a> 
      <dl class="layui-nav-child layui-nav-child-c"> 
       <dd class="layui-hide-sm layui-show-xs" lay-unselect> <a href="https://gitee.com/sentsin/layui/issues" target="_blank" rel="nofollow">问题反馈</a> 
        <hr> 
       </dd> 
       <dd lay-unselect>
        <a href="/alone.html" target="_blank" lay-unselect>独立组件</a>
       </dd> 
       <dd lay-unselect>
        <a href="/extend/" target="_blank">扩展组件</a>
       </dd> 
      </dl> </li> 
     <li class="layui-nav-item layui-hide-xs"> <a href="//gitee.com/sentsin/layui/issues" target="_blank" rel="nofollow">反馈</a> </li> 
    </ul> 
   </div> 
  </div> <!-- 让IE8/9支持媒体查询，从而兼容栅格 --> <!--[if lt IE 9]>
  <script src="https://cdn.staticfile.org/html5shiv/r29/html5.min.js"></script>
  <script src="https://cdn.staticfile.org/respond.js/1.4.2/respond.min.js"></script>
<![endif]--> 
  <ul class="site-dir"> 
   <li><a href="#use"><cite>使用</cite></a></li> 
   <li><a href="#render"> <cite>更新渲染</cite> <span class="layui-badge-dot"></span> </a></li> 
   <li><a href="#attr"><cite>预设元素属性</cite></a></li> 
   <li><a href="#on"><cite>事件触发</cite></a></li> 
   <li><a href="#onselect"><cite>触发select选择</cite></a></li> 
   <li><a href="#oncheckbox"><cite>触发checkbox复选</cite></a></li> 
   <li><a href="#onswitch"><cite>触发switch开关</cite></a></li> 
   <li><a href="#onradio"><cite>触发radio单选</cite></a></li> 
   <li><a href="#onsubmit"><cite>触发submit提交</cite></a></li> 
   <li><a href="#val"><cite>表单赋值 / 取值</cite> <span class="layui-badge-dot"></span></a></li> 
   <li><a href="#verify"><cite>表单验证</cite> <span class="layui-badge-dot"></span></a></li> 
  </ul> 
  <div class="layui-container layui-row"> 
   <div class="layui-col-md3"> 
    <div class="layui-panel site-menu"> 
     <ul class="layui-menu layui-menu-lg"> 
      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}"> 
       <div class="layui-menu-body-title">
         基础说明 
       </div> 
       <hr> 
       <ul> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/index.html"> <span>开始使用 </span> <span class="layui-font-12 layui-font-gray">Getting Started</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/base/infrastructure.html"> <span>底层方法 </span> <span class="layui-font-12 layui-font-gray">基础支撑</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/base/element.html"> <span>页面元素 </span> <span class="layui-font-12 layui-font-gray">规范 公共类 属性</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/base/modules.html"> <span>模块规范 </span> <span class="layui-font-12 layui-font-gray">使用 扩展</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/base/faq.html"> <span>常见问题 </span> <span class="layui-font-12 layui-font-gray">FAQ</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/base/changelog.html"> <span>更新日志 </span> <span class="layui-font-12 layui-font-gray">changelog</span> <span class="layui-badge-dot"></span> </a> 
         </div> </li> 
       </ul> </li> 
      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}"> 
       <div class="layui-menu-body-title">
         页面元素 
       </div> 
       <hr> 
       <ul> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/layout.html"> <span>布局 </span> <span class="layui-font-12 layui-font-gray">栅格 后台管理布局</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/color.html"> <span>颜色 </span> <span class="layui-font-12 layui-font-gray">主色调 颜色搭配</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/icon.html"> <span>图标 </span> <span class="layui-font-12 layui-font-gray">iconfont 字体图标</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/anim.html"> <span>动画 </span> <span class="layui-font-12 layui-font-gray">内置 CSS3 动画</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/button.html"> <span>按钮 </span> <span class="layui-font-12 layui-font-gray">button</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/form.html"> <span>表单 </span> <span class="layui-font-12 layui-font-gray">form 元素集合</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/nav.html"> <span>导航 </span> <span class="layui-font-12 layui-font-gray">nav 面包屑</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/menu.html"> <span>菜单 </span> <span class="layui-font-12 layui-font-gray">menu 基础菜单</span> <span class="layui-badge-dot"></span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/tab.html"> <span>选项卡 </span> <span class="layui-font-12 layui-font-gray">Tabs 切换</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/progress.html"> <span>进度条 </span> <span class="layui-font-12 layui-font-gray">progress</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/panel.html"> <span>面板 </span> <span class="layui-font-12 layui-font-gray">panel 卡片 折叠</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/table.html"> <span>表格 </span> <span class="layui-font-12 layui-font-gray">静态 table</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/badge.html"> <span>徽章 </span> <span class="layui-font-12 layui-font-gray">小圆点 小边框</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/timeline.html"> <span>时间线 </span> <span class="layui-font-12 layui-font-gray">timeline</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/element/auxiliar.html"> <span>辅助 </span> <span class="layui-font-12 layui-font-gray">引用 字段集 横线等</span> </a> 
         </div> </li> 
       </ul> </li> 
      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}"> 
       <div class="layui-menu-body-title">
         内置模块 
       </div> 
       <hr> 
       <ul> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/layer.html"> <span>弹出层 </span> <span class="layui-font-12 layui-font-gray">layer</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/laydate.html"> <span>日期与时间选择 </span> <span class="layui-font-12 layui-font-gray">laydate</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/laypage.html"> <span>分页 </span> <span class="layui-font-12 layui-font-gray">laypage</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/laytpl.html"> <span>模板引擎 </span> <span class="layui-font-12 layui-font-gray">laytpl</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/table.html"> <span>数据表格 </span> <span class="layui-font-12 layui-font-gray">table</span> </a> 
         </div> </li> 
        <li class="layui-menu-item-checked2"> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/form.html"> <span>表单 </span> <span class="layui-font-12 layui-font-gray">form</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/upload.html"> <span>文件上传 </span> <span class="layui-font-12 layui-font-gray">upload</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/dropdown.html"> <span>下拉菜单 </span> <span class="layui-font-12 layui-font-gray">dropdown</span> <span class="layui-badge-dot"></span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/transfer.html"> <span>穿梭框 </span> <span class="layui-font-12 layui-font-gray">transfer</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/tree.html"> <span>树形组件 </span> <span class="layui-font-12 layui-font-gray">tree</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/colorpicker.html"> <span>颜色选择器 </span> <span class="layui-font-12 layui-font-gray">colorpicker</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/element.html"> <span>常用元素操作 </span> <span class="layui-font-12 layui-font-gray">element</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/slider.html"> <span>滑块 </span> <span class="layui-font-12 layui-font-gray">slider</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/rate.html"> <span>评分 </span> <span class="layui-font-12 layui-font-gray">rate</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/carousel.html"> <span>轮播 </span> <span class="layui-font-12 layui-font-gray">carousel</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/flow.html"> <span>流加载 </span> <span class="layui-font-12 layui-font-gray">flow</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/util.html"> <span>工具组件 </span> <span class="layui-font-12 layui-font-gray">util</span> </a> 
         </div> </li> 
        <li class=""> 
         <div class="layui-menu-body-title"> <a href="/doc/modules/code.html"> <span>代码高亮显示 </span> <span class="layui-font-12 layui-font-gray">code</span> </a> 
         </div> </li> 
       </ul> </li> 
     </ul> 
    </div> 
    <div class="layui-hide-v">
      - 
    </div> 
   </div> 
   <div class="layui-col-md9 site-content"> 
    <h1 class="site-h1"><i class="layui-icon"></i> 表单模块文档 - layui.form</h1> 
    <blockquote class="site-text layui-elem-quote">
      我们通常会在最常用的模块上耗费更多的精力，用尽可能简单的方式诠释 layui 所带来的便捷性。显而易见，form 是我们非常看重的一块。于是它试图用一贯极简的姿态，去捕获你对它的深深青睐。寄托在原始表单元素上的属性设定，及其全自动的初始渲染，和基于事件驱动的接口书写方式，会让你觉得，传统模式下的组件调用形式，也可以是那样的优雅、简单。然而文字的陈述始终是苍白的，所以用行动慢慢感受 layui.form 给你的项目带来的效率提升吧。 
    </blockquote> 
    <blockquote class="site-text layui-elem-quote"> 
     <p>模块加载名称：<em>form</em></p> 
    </blockquote> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="use">使用</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p> layui 针对各种表单元素做了较为全面的UI支持，你无需去书写那些 UI 结构，你只需要写 HTML 原始的 input、select、textarea 这些基本的标签即可。我们在 UI 上的渲染只要求一点，你必须给表单体系所在的父元素加上<em>class="layui-form"</em>，一切的工作都会在你加载完form模块后，自动完成。如下是一个最基本的例子：</p> 
     <pre class="layui-code" lay-title="layui.form小例子">&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;head&gt;
&lt;meta charset="utf-8"&gt;
&lt;title&gt;layui.form小例子&lt;/title&gt;
&lt;link rel="stylesheet" href="layui.css" media="all"&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;form class="layui-form"&gt; &lt;!-- 提示：如果你不想用form，你可以换成div等任何一个普通元素 --&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;输入框&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;input type="text" name="" placeholder="请输入" autocomplete="off" class="layui-input"&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;下拉选择框&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;select name="interest" lay-filter="aihao"&gt;
        &lt;option value="0"&gt;写作&lt;/option&gt;
        &lt;option value="1"&gt;阅读&lt;/option&gt;
      &lt;/select&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;复选框&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;input type="checkbox" name="like[write]" title="写作"&gt;
      &lt;input type="checkbox" name="like[read]" title="阅读"&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;开关关&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;input type="checkbox" lay-skin="switch"&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;开关开&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;input type="checkbox" checked lay-skin="switch"&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;label class="layui-form-label"&gt;单选框&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;input type="radio" name="sex" value="0" title="男"&gt;
      &lt;input type="radio" name="sex" value="1" title="女" checked&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item layui-form-text"&gt;
    &lt;label class="layui-form-label"&gt;请填写描述&lt;/label&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;textarea placeholder="请输入内容" class="layui-textarea"&gt;&lt;/textarea&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="layui-form-item"&gt;
    &lt;div class="layui-input-block"&gt;
      &lt;button class="layui-btn" lay-submit lay-filter="*"&gt;立即提交&lt;/button&gt;
      &lt;button type="reset" class="layui-btn layui-btn-primary"&gt;重置&lt;/button&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;!-- 更多表单结构排版请移步文档左侧【页面元素-表单】一项阅览 --&gt;
&lt;/form&gt;
&lt;script src="layui.js"&gt;&lt;/script&gt;
&lt;script&gt;
layui.use('form', function(){
  var form = layui.form;
  
  //各种基于事件的操作，下面会有进一步介绍
});
&lt;/script&gt;
&lt;/body&gt;
&lt;/html&gt;
      </pre> 
     <p>正如你上述看到的，你必须放入 layui 所<em>规范的元素结构</em>，form 模块才会对其进行重置渲染。值得注意的是，在具体的每一块表单元素中，你仍是像往日一样写 input 等标签即可。另外，我们对我们所规范的结构进行了响应式的支持，而针对一些不同的表单排版，比如行内表单，你也只需要设定我们所定义好的 class 即可。关于这一块，你可以移步页面元素的表单文档中做详细了解。而事实上你的大部分焦点可能也在那里，但当前这篇文档主要还是介绍 form 整体模块。</p> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="render">更新渲染</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>有些时候，你的有些表单元素可能是动态插入的。这时 form 模块 的自动化渲染是会对其失效的。虽然我们没有双向绑定机制（因为我们叫经典模块化框架，<em>偷笑.gif</em>） 但没有关系，你只需要执行 <em>form.render(type, filter);</em> 方法即可。</p> 
     <p>第一个参数：type，为表单的 type 类型，可选。默认对全部类型的表单进行一次更新。可局部刷新的 type 如下表：</p> 
     <table class="layui-table"> 
      <thead> 
       <tr> 
        <th>参数（type）值</th> 
        <th>描述</th> 
       </tr> 
      </thead> 
      <tbody> 
       <tr> 
        <td>select</td> 
        <td>刷新select选择框渲染</td> 
       </tr> 
       <tr> 
        <td>checkbox</td> 
        <td>刷新checkbox复选框（含开关）渲染</td> 
       </tr> 
       <tr> 
        <td>radio</td> 
        <td>刷新radio单选框框渲染</td> 
       </tr> 
      </tbody> 
     </table> 
     <pre class="layui-code" lay-title="例子">form.render(); //更新全部
form.render('select'); //刷新select选择框渲染
//……
      </pre> 
     <p>第二个参数：filter，为 <em>class="layui-form"</em> 所在元素的 <em>lay-filter=""</em> 的值。你可以借助该参数，对表单完成局部更新。</p> 
     <pre class="layui-code" lay-title="例子">【HTML】
&lt;div class="layui-form" lay-filter="test1"&gt;
  …
&lt;/div&gt;
 
&lt;div class="layui-form" lay-filter="test2"&gt;
  …
&lt;/div&gt;
      
【JavaScript】
form.render(null, 'test1'); //更新 lay-filter="test1" 所在容器内的全部表单状态
form.render('select', 'test2'); //更新 lay-filter="test2" 所在容器内的全部 select 状态
//……
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="attr">预设元素属性</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>事实上在使用表单时，你的一半精力可能会在元素本身上。所以我们把一些基础属性的配置恰恰安放在了标签本身上。如：</p> 
     <pre class="layui-code">&lt;input type="text" lay-verify="email"&gt;
&lt;input type="checkbox" checked lay-skin="switch" lay-filter="encrypt" title="是否加密"&gt;
&lt;button lay-submit&gt;提交&lt;/button&gt;
      </pre> 
     <p>上述的<em>lay-verify</em>、<em>lay-skin</em>、<em>lay-filter</em>、<em>lay-submit</em>神马的都是我们所说的预设的元素属性，他们可以使得一些交互操作交由form模块内部、或者你来借助form提供的JS接口精确控制。目前我们可支持的属性如下表所示：</p> 
     <table class="layui-table"> 
      <thead> 
       <tr> 
        <th style="width: 80px;">属性名</th> 
        <th style="width: 150px;">属性值</th> 
        <th>说明</th> 
       </tr> 
      </thead> 
      <tbody> 
       <tr> 
        <td>title</td> 
        <td>任意字符</td> 
        <td>设定元素名称，一般用于checkbox、radio框</td> 
       </tr> 
       <tr> 
        <td>lay-skin</td> 
        <td> switch（开关风格） primary（原始风格） </td> 
        <td>定义元素的风格，目前只对 <em>checkbox</em> 元素有效，可将其转变为开关样式</td> 
       </tr> 
       <tr> 
        <td>lay-ignore</td> 
        <td>任意字符或不设值</td> 
        <td>是否忽略元素美化处理。设置后，将不会对该元素进行初始化渲染，即保留系统风格</td> 
       </tr> 
       <tr> 
        <td>lay-filter</td> 
        <td>任意字符</td> 
        <td>事件过滤器，主要用于事件的精确匹配，跟选择器是比较类似的。其实它并不私属于form模块，它在 layui 的很多基于事件的接口中都会应用到。</td> 
       </tr> 
       <tr> 
        <td>lay-verify</td> 
        <td>required（必填项）<br>phone（手机号）<br>email（邮箱）<br>url（网址）<br>number（数字）<br>date（日期）<br>identity（身份证）<br>自定义值</td> 
        <td>同时支持多条规则的验证，格式：<em>lay-verify="验证A|验证B"</em> <br>如：<em>lay-verify="required|phone|number"</em> <br><br>另外，除了我们内置的校验规则，你还可以给他设定任意的值，比如lay-verify="pass"，那么你就需要借助form.verify()方法对pass进行一个校验规则的定义。<a href="#verify">详见表单验证</a></td> 
       </tr> 
       <tr> 
        <td>lay-verType</td> 
        <td> tips（吸附层）<br>alert（对话框）<br>msg（默认） </td> 
        <td>用于定义异常提示层模式。</td> 
       </tr> 
       <tr> 
        <td>lay-reqText</td> 
        <td> 任意字符 </td> 
        <td> 用于自定义必填项（即设定了 lay-verify="required" 的表单）的提示文本 <br> 注意：<em>该功能为 layui 2.5.0 新增</em> </td> 
       </tr> 
       <tr> 
        <td>lay-submit</td> 
        <td>无需填写值</td> 
        <td>绑定触发提交的元素，如button</td> 
       </tr> 
      </tbody> 
     </table> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="on">事件触发</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>语法：<a>form.on('event(过滤器值)', callback);</a></p> 
     <p>form模块在 layui 事件机制中注册了专属事件，所以当你使用layui.onevent()自定义模块事件时，请勿占用form名。form支持的事件如下：</p> 
     <table class="layui-table"> 
      <thead> 
       <tr> 
        <th>event</th> 
        <th>描述</th> 
       </tr> 
      </thead> 
      <tbody> 
       <tr> 
        <td>select</td> 
        <td>触发select下拉选择事件</td> 
       </tr> 
       <tr> 
        <td>checkbox</td> 
        <td>触发checkbox复选框勾选事件</td> 
       </tr> 
       <tr> 
        <td>switch</td> 
        <td>触发checkbox复选框开关事件</td> 
       </tr> 
       <tr> 
        <td>radio</td> 
        <td>触发radio单选框事件</td> 
       </tr> 
       <tr> 
        <td>submit</td> 
        <td>触发表单提交事件</td> 
       </tr> 
      </tbody> 
     </table> 
     <p>默认情况下，事件所触发的是全部的form模块元素，但如果你只想触发某一个元素，使用事件过滤器即可。<br>如：<em>&lt;select lay-filter="test"&gt;&lt;/select&gt;</em></p> 
     <pre class="layui-code">form.on('select(test)', function(data){
  console.log(data);
});
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="onselect">触发select选择</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>下拉选择框被选中时触发，回调函数返回一个object参数，携带两个成员：</p> 
     <pre class="layui-code" lay-title="语法">form.on('select(filter)', function(data){
  console.log(data.elem); //得到select原始DOM对象
  console.log(data.value); //得到被选中的值
  console.log(data.othis); //得到美化后的DOM对象
});      
      </pre> 
     <p>请注意：如果你想触发所有的select，去掉过滤器<em>(filter)</em>即可。下面将不再对此进行备注。</p> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="oncheckbox">触发checkbox复选</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>复选框点击勾选时触发，回调函数返回一个object参数，携带两个成员：</p> 
     <pre class="layui-code" lay-title="语法">form.on('checkbox(filter)', function(data){
  console.log(data.elem); //得到checkbox原始DOM对象
  console.log(data.elem.checked); //是否被选中，true或者false
  console.log(data.value); //复选框value值，也可以通过data.elem.value得到
  console.log(data.othis); //得到美化后的DOM对象
});        
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="onswitch">触发switch开关</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>开关被点击时触发，回调函数返回一个object参数，携带两个成员：</p> 
     <pre class="layui-code" lay-title="语法">form.on('switch(filter)', function(data){
  console.log(data.elem); //得到checkbox原始DOM对象
  console.log(data.elem.checked); //开关是否开启，true或者false
  console.log(data.value); //开关value值，也可以通过data.elem.value得到
  console.log(data.othis); //得到美化后的DOM对象
});  
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="onradio">触发radio单选</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>radio单选框被点击时触发，回调函数返回一个object参数，携带两个成员：</p> 
     <pre class="layui-code" lay-title="语法">form.on('radio(filter)', function(data){
  console.log(data.elem); //得到radio原始DOM对象
  console.log(data.value); //被点击的radio的value值
});  
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="onsubmit">触发submit提交</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>按钮点击或者表单被执行提交时触发，其中回调函数只有在验证全部通过后才会进入，回调返回三个成员：</p> 
     <pre class="layui-code" lay-title="语法">form.on('submit(*)', function(data){
  console.log(data.elem) //被执行事件的元素DOM对象，一般为button对象
  console.log(data.form) //被执行提交的form对象，一般在存在form标签时才会返回
  console.log(data.field) //当前容器的全部表单字段，名值对形式：{name: value}
  return false; //阻止表单跳转。如果需要表单跳转，去掉这段即可。
});
      </pre> 
     <p>再次温馨提示：上述的<em>submit(*)</em>中的 <em>*</em> 号为事件过滤器的值，是在你绑定执行提交的元素时设定的，如：</p> 
     <pre class="layui-code">&lt;button lay-submit lay-filter="*"&gt;提交&lt;/button&gt;     
      </pre> 
     <p>你可以把*号换成任意的值，如：<em>lay-filter="go"</em>，但触发事件时也要改成 <em>form.on('submit(go)', callback);</em> </p> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="val">表单赋值 / 取值</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>语法：<em>form.val('filter', object);</em></p> 
     <p> 用于给指定表单集合的元素赋值和取值。如果 object 参数存在，则为赋值；如果 object 参数不存在，则为取值。 <br>注：<span style="color: #FF5722;">其中「取值」功能为 layui 2.5.5 开始新增</span> </p> 
     <pre class="layui-code">//给表单赋值
form.val("formTest", { //formTest 即 class="layui-form" 所在元素属性 lay-filter="" 对应的值
  "username": "贤心" // "name": "value"
  ,"sex": "女"
  ,"auth": 3
  ,"check[write]": true
  ,"open": false
  ,"desc": "我爱layui"
});
 
//获取表单区域所有值
var data1 = form.val("formTest");
      </pre> 
     <p>第二个参数中的键值是表单元素对应的 <em>name</em> 和 <em>value</em>。</p> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="verify">表单验证</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>我们对表单的验证进行了非常巧妙的支持，大多数时候你只需要在表单元素上加上 <em>lay-verify=""</em> 属性值即可。如：</p> 
     <pre class="layui-code">&lt;input type="text" lay-verify="email"&gt; 
 
还同时支持多条规则的验证，如下：
&lt;input type="text" lay-verify="required|phone|number"&gt;
      </pre> 
     <p> 上述对输入框定义了一个邮箱规则的校验，它会在 form 模块内部完成。目前我们内置的校验支持见上文的：<a href="#attr">预设元素属性</a> </p> 
     <p>除了内置的校验规则外，你还可以自定义验证规则，通常对于比较复杂的校验，这是非常有必要的。</p> 
     <pre class="layui-code" lay-title="语法">form.verify({
  username: function(value, item){ //<em>value：表单的值、item：表单的DOM对象</em>
    if(!new RegExp("^[a-zA-Z0-9_\u4e00-\u9fa5\\s·]+$").test(value)){
      return '用户名不能有特殊字符';
    }
    if(/(^\_)|(\__)|(\_+$)/.test(value)){
      return '用户名首尾不能出现下划线\'_\'';
    }
    if(/^\d+\d+\d$/.test(value)){
      return '用户名不能全为数字';
    }
    
    //如果不想自动弹出默认提示框，可以直接返回 true，这时你可以通过其他任意方式提示（v2.5.7 新增）
    if(value === 'xxx'){
      alert('用户名不能为敏感词');
      return true;
    }
  }
  
  //我们既支持上述函数式的方式，也支持下述数组的形式
  //数组的两个值分别代表：[正则匹配、匹配不符时的提示文字]
  ,pass: [
    /^[\S]{6,12}$/
    ,'密码必须6到12位，且不能出现空格'
  ] 
});      
      </pre> 
     <p>当你自定义了类似上面的验证规则后，你只需要把 key 赋值给输入框的 <em>lay-verify</em> 属性即可：</p> 
     <pre class="layui-code">&lt;input type="text" lay-verify="username" placeholder="请输入用户名"&gt;
&lt;input type="password" lay-verify="pass" placeholder="请输入密码"&gt;
      </pre> 
    </div> 
    <div class="site-title"> 
     <fieldset>
      <legend><a name="other">再次温馨提示一下</a></legend>
     </fieldset> 
    </div> 
    <div class="site-text"> 
     <p>针对一些不同的表单排版，比如行内表单、整体表单风格、按钮风格等等，请移步到文档导航左侧【<em>页面元素</em>】下的指定分类即可。</p> 
    </div> 
    <div class="layui-elem-quote"> 
     <p>layui - 在每一个细节中，用心与你沟通</p> 
    </div> 
   </div> 
  </div> 
  <div class="layui-footer footer footer-doc"> 
   <p> Copyright © 2021 <a href="/index.html">layui.itmtr.cn</a> MIT Licensed</p> 
   <p> </p>
  </div> 
  <script>
window.global = {
  pageType: 'doc'
  ,preview: function(){
    var preview = document.getElementById('LAY_preview');
    return preview ? preview.innerHTML : '';
  }()
};
</script> 
  <div class="site-tree-mobile layui-hide"> <i class="layui-icon layui-icon-spread-left"></i> 
  </div> 
  <div class="site-mobile-shade"></div> 
  <script src="/layui/dist/layui.js" charset="utf-8"></script> 
  <script>
layui.config({
  base: '/static/lay/modules/layui/'
  ,version: '1632659138225'
}).use('global');
</script>  
 </body>
<script src="/common/common.js"></script>
</html>